Api.RequestSlaveState method

Requests an EtherCAT slave to go into the specified EtherCAT state. For example, if the state is Op, and your requested state is PreOp, the slave will change the state to Op -> SafeOp -> PreOp. If the state is Init and your requested state is Op, the slave will change the state to Init -> PreOp -> SafeOp -> Op.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus RequestSlaveState(
       int SlaveId,
       EthercatState State
)

Public Function RequestSlaveState(
       SlaveId As Integer,
       State As EthercatState
) As KsCommandStatus

Parameters

SlaveId

Type: int

The index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect for more details.

State

Type: EthercatState

The requested EtherCAT state.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

Both EtherCAT master and slave need to be in one of the supported states.
It is not possible to request the EtherCAT state that is higher than the master state. For further details about which states the master supports, see RequestState.

Usable EtherCAT states

ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A